Joe/596 always generate query id if not set #603
+97
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances the ClickHouse client to automatically generate UUID v4 query_id values for all queries when not explicitly provided, improving observability and debugging capabilities by enabling correlation between application and ClickHouse query logs.
- Added
autogenerate_query_idsetting (default:True) to control automatic query ID generation - Centralized query ID generation in
_raw_requestmethod to cover all query paths - Added comprehensive test coverage for auto-generation, manual override, and query log verification
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| clickhouse_connect/common.py | Registers new autogenerate_query_id global setting with default value True |
| clickhouse_connect/driver/httpclient.py | Adds constructor parameter and implements query ID auto-generation in _raw_request |
| tests/integration_tests/test_client.py | Adds UUID v4 validation helper and comprehensive test coverage for query ID behavior |
| CHANGELOG.md | Documents the new auto-generation feature |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]> Signed-off-by: Joe S. <[email protected]>
Signed-off-by: Joe S. <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR introduces a backwards-compatible enhancement to automatically generate a UUID4
query_idclient-side by default when not explicitly provided. This will greatly aid in correlating application logs with ClickHouse query logs during debugging, performance investigations, incident response, etc.query_idfor every query/command/insert operationquery_idvalues are always respected. This will not override_raw_requestto cover all query paths (query,query_df,query_arrow,raw_query,command,insert, etc.)Checklist
Delete items not relevant to your PR:
Closes #596